py domain: Ignore aliases for resolving :any: cross-references
#10089
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ewjoachim
changed the title
ewjoachim
force-pushed
the
py-domain-canonical-any-10088
branch
8 times, most recently
from
e9eb629 to
8b8ec94
Compare
ewjoachim
force-pushed
the
py-domain-canonical-any-10088
branch
from
8b8ec94 to
29de8ab
Compare
|
Hm, hey, anyone ? |
|
@tk0miya if you have any lead as to what I can do to help this PR go forward ? |
AA-Turner
reviewed
May 27, 2022
sphinx/domains/python.py
Outdated
Comment on lines
1417
to
1376
| if len(matches) > 1: | ||
| # Remove all duplicated matches | ||
| matches = [(name, obj) for name, obj in matches if not obj.aliased] | ||
|
|
||
| for name, obj in matches: | ||
| if obj[2] == 'module': |
There was a problem hiding this comment.
Skips a list comprehension step
Suggested change
| if len(matches) > 1: | |
| # Remove all duplicated matches | |
| matches = [(name, obj) for name, obj in matches if not obj.aliased] | |
| for name, obj in matches: | |
| if obj[2] == 'module': | |
| for name, obj in matches: | |
| if len(matches) > 1 and obj.aliased: | |
| # Skip duplicated matches | |
| continue | |
| if obj[2] == 'module': |
A
There was a problem hiding this comment.
Done (I've stored len(matches) > 1 in a variable)
|
Please update CHANGES for A |
ewjoachim
force-pushed
the
py-domain-canonical-any-10088
branch
4 times, most recently
from
1d27518 to
8459887
Compare
|
We should be all good now :) |
ewjoachim
force-pushed
the
py-domain-canonical-any-10088
branch
from
8459887 to
85616e5
Compare
|
Rebased after 5.0 release :) |
|
(is it expected that the bug label has not been set on the PR ?) |
AA-Turner
approved these changes
Jun 2, 2022
ewjoachim
force-pushed
the
py-domain-canonical-any-10088
branch
from
85616e5 to
4883907
Compare
|
Rebased after 5.0.1. Also, see #10515 |
AA-Turner
approved these changes
Jun 5, 2022
ewjoachim
force-pushed
the
py-domain-canonical-any-10088
branch
from
4883907 to
4245632
Compare
|
Oh, I see you added this to the 5.1.0 milestone, I'll update CHANGES so that it appears in the 5.1.0 section :) |
ewjoachim
force-pushed
the
py-domain-canonical-any-10088
branch
from
4245632 to
86b89b6
Compare
AA-Turner
reviewed
Jun 26, 2022
AA-Turner
reviewed
Jun 26, 2022
AA-Turner
approved these changes
Jun 26, 2022
AA-Turner
changed the title
:any: cross-references
|
Thanks @ewjoachim! A |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Subject: closes #10088 (EDIT: already closed as duplicate) and also closes #9577 I believe, since they are duplicates.
With this PR, we can use
:any:again in Sphinx v4.x with autodoc & python aliases.I believe that everything that used to work will still work
Feature or Bugfix
Purpose
See #10088
The issue is that that autodoc adds
canonical(which is a good thing), andanydoesn't play well withaliasedobjects (which is the bad thing we're solving here)Detail
What I did, it's all in the python domain code:
anylookups, and the test checks that there is no warning.Just to be sure, I've run the test before the fix and it's red, and after the fix, it's green.
I don't know if this qualifies for a "hotfix" (not sure).
Relates
anyxref resolutions